<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArSoundsQueue::Item Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArSoundsQueue_1_1Item.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classArSoundsQueue_1_1Item-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArSoundsQueue::Item Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A sound item in the queue, with callbacks for dealing with the item and the data to pass to those callbacks.  
 <a href="classArSoundsQueue_1_1Item.html#details">More...</a></p>

<p><code>#include &lt;ArSoundsQueue.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a3e35023ce74f5a007189d01626200745"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArSoundsQueue_1_1Item.html#a3e35023ce74f5a007189d01626200745">done</a> ()</td></tr>
<tr class="memdesc:a3e35023ce74f5a007189d01626200745"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by sound queue thread after playing this item by calling done callbacks.  <a href="#a3e35023ce74f5a007189d01626200745">More...</a><br /></td></tr>
<tr class="separator:a3e35023ce74f5a007189d01626200745"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19e7c7f25dc43228a537d8015c3b4928"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArSoundsQueue_1_1Item.html#a19e7c7f25dc43228a537d8015c3b4928">interrupt</a> ()</td></tr>
<tr class="memdesc:a19e7c7f25dc43228a537d8015c3b4928"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by sound queue to interrupt this item by calling interrupt callbacks.  <a href="#a19e7c7f25dc43228a537d8015c3b4928">More...</a><br /></td></tr>
<tr class="separator:a19e7c7f25dc43228a537d8015c3b4928"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaca0e4327ffc4d9131587f3df5358045"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaca0e4327ffc4d9131587f3df5358045"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Item</b> (std::string _data, <a class="el" href="classArSoundsQueue.html#adcaafc197f106de866c854ce3f9f468a">ItemType</a> _type, std::string _params=&quot;&quot;, int priority=0)</td></tr>
<tr class="separator:aaca0e4327ffc4d9131587f3df5358045"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd24e6963a85b9f3ef88eb2e57f1321c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd24e6963a85b9f3ef88eb2e57f1321c"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Item</b> (std::string _data, <a class="el" href="classArSoundsQueue.html#adcaafc197f106de866c854ce3f9f468a">ItemType</a> _type, std::string _params, int priority, std::list&lt; <a class="el" href="classArSoundsQueue.html#a1670bc04bab708282683f9862d822eeb">PlayItemFunctor</a> * &gt; callbacks)</td></tr>
<tr class="separator:acd24e6963a85b9f3ef88eb2e57f1321c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31e262ba437916e3a0f084323f1a530f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31e262ba437916e3a0f084323f1a530f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Item</b> (const <a class="el" href="classArSoundsQueue_1_1Item.html">ArSoundsQueue::Item</a> &amp;toCopy)</td></tr>
<tr class="separator:a31e262ba437916e3a0f084323f1a530f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca85d80aaca414979ec1dd00845d9950"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aca85d80aaca414979ec1dd00845d9950"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArSoundsQueue_1_1Item.html#aca85d80aaca414979ec1dd00845d9950">operator==</a> (const <a class="el" href="classArSoundsQueue_1_1Item.html">Item</a> &amp;other) const </td></tr>
<tr class="memdesc:aca85d80aaca414979ec1dd00845d9950"><td class="mdescLeft">&#160;</td><td class="mdescRight">Note: does not compare priority! <br /></td></tr>
<tr class="separator:aca85d80aaca414979ec1dd00845d9950"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99431b62b187a027e02493355367853a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArSoundsQueue_1_1Item.html#a99431b62b187a027e02493355367853a">play</a> ()</td></tr>
<tr class="memdesc:a99431b62b187a027e02493355367853a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called by sound queue to play this item by calling play callbacks.  <a href="#a99431b62b187a027e02493355367853a">More...</a><br /></td></tr>
<tr class="separator:a99431b62b187a027e02493355367853a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aba3996c04fefd80d72b439b7bec8fcb6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba3996c04fefd80d72b439b7bec8fcb6"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>data</b></td></tr>
<tr class="separator:aba3996c04fefd80d72b439b7bec8fcb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeeaf6819fc48ef7aedc4a513c57d8651"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeeaf6819fc48ef7aedc4a513c57d8651"></a>
std::list&lt; <a class="el" href="classArFunctor.html">ArFunctor</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>doneCallbacks</b></td></tr>
<tr class="separator:aeeaf6819fc48ef7aedc4a513c57d8651"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c0e184b1bc09449539729cfb42f17aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c0e184b1bc09449539729cfb42f17aa"></a>
std::list&lt; <a class="el" href="classArFunctor.html">InterruptItemFunctor</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>interruptCallbacks</b></td></tr>
<tr class="separator:a7c0e184b1bc09449539729cfb42f17aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d07ab86c1df976ad336804115c3dbef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2d07ab86c1df976ad336804115c3dbef"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>params</b></td></tr>
<tr class="separator:a2d07ab86c1df976ad336804115c3dbef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a556bab0671b278f05dde0b4eaaa4b6b2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a556bab0671b278f05dde0b4eaaa4b6b2"></a>
std::list&lt; <a class="el" href="classArSoundsQueue.html#a831d244f0f9f5740c58131e4cd663050">PlaybackConditionFunctor</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>playbackConditionCallbacks</b></td></tr>
<tr class="separator:a556bab0671b278f05dde0b4eaaa4b6b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02733ee52eca81c82fa4b4e8fb324134"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a02733ee52eca81c82fa4b4e8fb324134"></a>
std::list&lt; <a class="el" href="classArSoundsQueue.html#a1670bc04bab708282683f9862d822eeb">PlayItemFunctor</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>playCallbacks</b></td></tr>
<tr class="separator:a02733ee52eca81c82fa4b4e8fb324134"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4e268981faeaba8064e27e4532ab9eef"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e268981faeaba8064e27e4532ab9eef"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>priority</b></td></tr>
<tr class="separator:a4e268981faeaba8064e27e4532ab9eef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a127d30810190cc1410b5ab4cda4f3195"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a127d30810190cc1410b5ab4cda4f3195"></a>
<a class="el" href="classArSoundsQueue.html#adcaafc197f106de866c854ce3f9f468a">ItemType</a>&#160;</td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
<tr class="separator:a127d30810190cc1410b5ab4cda4f3195"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A sound item in the queue, with callbacks for dealing with the item and the data to pass to those callbacks. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="soundsQueueExample_8cpp-example.html#_a23">soundsQueueExample.cpp</a>.</dd>
</dl></div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3e35023ce74f5a007189d01626200745"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ArSoundsQueue::Item::done </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Called by sound queue thread after playing this item by calling done callbacks. </p>

</div>
</div>
<a class="anchor" id="a19e7c7f25dc43228a537d8015c3b4928"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ArSoundsQueue::Item::interrupt </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Called by sound queue to interrupt this item by calling interrupt callbacks. </p>

</div>
</div>
<a class="anchor" id="a99431b62b187a027e02493355367853a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ArSoundsQueue::Item::play </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Called by sound queue to play this item by calling play callbacks. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>ArSoundsQueue.h</li>
<li>ArSoundsQueue.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArSoundsQueue.html">ArSoundsQueue</a></li><li class="navelem"><a class="el" href="classArSoundsQueue_1_1Item.html">Item</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
